home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / HELPTOPIC.PY < prev    next >
Encoding:
Python Source  |  2000-06-09  |  9.8 KB  |  300 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. import Acquisition
  87. from ComputedAttribute import ComputedAttribute
  88. from OFS.SimpleItem import Item
  89. from Globals import Persistent, HTML, HTMLFile, ImageFile
  90. from OFS.DTMLDocument import DTMLDocument
  91. from OFS.PropertyManager import PropertyManager
  92. import os.path
  93. import string
  94.  
  95. class HelpTopicBase:
  96.     "Mix-in Help Topic support class"
  97.  
  98.     _properties=(
  99.         {'id':'title', 'type':'string', 'mode':'w'},
  100.         {'id':'categories', 'type':'multiple selection',
  101.          'select_variable':'categories_values', 'mode':'w'},
  102.         {'id':'permissions', 'type':'multiple selection',
  103.          'select_variable':'permissions_values', 'mode':'w'},
  104.         )
  105.  
  106.     # default values
  107.     categories=('Content Manager Information',)
  108.     permissions=('View',)
  109.  
  110.     def _permissions_values(self):
  111.         perms=[]
  112.         for m in self.permission_settings():
  113.             perms.append(m['name'])
  114.         return perms
  115.     
  116.     permissions_values=ComputedAttribute(_permissions_values, 1)
  117.  
  118.     categories_values=(
  119.         'Content Manager Information',
  120.         'DTML Programmer Information',
  121.         'Python Programmer Information',
  122.         )
  123.  
  124.     def helpValues(self, REQUEST=None):
  125.         return ()
  126.  
  127.     def authorized(self, user):
  128.         "Is a given user authorized to view this Help Topic?"
  129.         if not self.permissions:
  130.             return 1
  131.         for perm in self.permissions:
  132.             if user.has_permission(perm, self):
  133.                 return 1
  134.         return 0
  135.     
  136.     # Indexable methods
  137.     # -----------------
  138.  
  139.     def SearchableText(self):
  140.         "The full text of the Help Topic, for indexing purposes"
  141.         raise "Unimplemented"
  142.  
  143.     def url(self):
  144.         "URL for indexing purposes"
  145.         return string.join(self.getPhysicalPath(), '/')
  146.  
  147.     # Private indexing methods
  148.     # ------------------------
  149.     
  150.     def manage_afterAdd(self, item, container):
  151.         self.index_object()
  152.  
  153.     def manage_afterClone(self, item):
  154.         self.index_object()
  155.  
  156.     def manage_beforeDelete(self, item, container):
  157.         self.unindex_object()
  158.  
  159.     def _setPropValue(self, id, value):
  160.         setattr(self,id,value)
  161.         self.reindex_object()
  162.  
  163.     def index_object(self, prefix=''):
  164.         self.get_catalog().catalog_object(self, prefix + self.url())
  165.  
  166.     def unindex_object(self, prefix=''):
  167.         self.get_catalog().uncatalog_object(prefix + self.url())
  168.  
  169.     def reindex_object(self):
  170.         self.unindex_object()
  171.         self.index_object()
  172.  
  173.     def get_catalog(self):
  174.         return self.catalog
  175.  
  176.  
  177. class HelpTopic(Acquisition.Implicit, HelpTopicBase, Item, PropertyManager, Persistent):
  178.     """
  179.     Abstract base class for Help Topics
  180.     """
  181.     
  182.     meta_type='Help Topic'
  183.     icon='p_/HelpTopic_icon'
  184.  
  185.     manage_options=(
  186.         {'label':'Properties', 'action':'manage_propertiesForm'},
  187.         {'label':'View', 'action':'index_html'},
  188.         )
  189.  
  190.     __ac_permissions__=(
  191.         ('View', ('index_html', 'SearchableText', 'url')),
  192.         ('Access contents information', ('helpValues',)),
  193.         )
  194.  
  195.     def index_html(self, REQUEST, RESPONSE):
  196.         "View the Help Topic"
  197.         raise "Unimplemented"
  198.  
  199.  
  200. class DTMLDocumentTopic(HelpTopicBase, DTMLDocument):
  201.     """
  202.     A user addable Help Topic based on DTML Document.
  203.     """
  204.     meta_type='Help Topic'
  205.     icon='p_/HelpTopic_icon'
  206.  
  207.     def munge(self,*args, **kw):
  208.         apply(DTMLDocument.munge, (self,) + args, kw)
  209.         self.reindex_object()
  210.  
  211.     def SearchableText(self):
  212.         return '%s %s' % (self.title, self.read())
  213.    
  214.  
  215. default_topic_content="""\
  216. <dtml-var standard_html_header>
  217. <h2><dtml-var title></h2>
  218. <p>This is the <dtml-var id> Help Topic.</p>
  219. <dtml-var standard_html_footer>
  220. """
  221.  
  222. class DTMLTopic(HelpTopic):
  223.     """
  224.     A basic Help Topic. Holds a HTMLFile object.
  225.     """
  226.     def __init__(self, id, title, file, permissions=None, categories=None):
  227.         self.id=id
  228.         self.title=title
  229.         file,ext=os.path.splitext(file)
  230.         prefix,file=os.path.split(file)
  231.         self.index_html=HTMLFile(file,prefix)
  232.         if permissions is not None:
  233.             self.permissions=permissions
  234.         if categories is not None:
  235.             self.categories=categories
  236.         
  237.     def SearchableText(self):
  238.         "The full text of the Help Topic, for indexing purposes"
  239.         return '%s %s' % (self.title, self.index_html.read())
  240.  
  241.         
  242. class TextTopic(HelpTopic):
  243.     """
  244.     A basic Help Topic. Holds a text file.
  245.     """
  246.     def __init__(self, id, title, file, permissions=None, categories=None):
  247.         self.id=id
  248.         self.title=title
  249.         self.obj=open(file).read()
  250.         if permissions is not None:
  251.             self.permissions=permissions
  252.         if categories is not None:
  253.             self.categories=categories
  254.         
  255.     def index_html(self, REQUEST=None):
  256.         "View the Help Topic"
  257.         return self.obj
  258.  
  259.     def SearchableText(self):
  260.         "The full text of the Help Topic, for indexing purposes"
  261.         return '%s %s' % (self.title, self.obj)
  262.  
  263.     
  264. class STXTopic(TextTopic):
  265.     """
  266.     A structured-text topic. Holds a HTMLFile object.
  267.     """
  268.     
  269.     index_html=HTML("""\
  270. <dtml-var standard_html_header>
  271. <dtml-var obj fmt="structured-text">
  272. <dtml-var standard_html_footer>""")
  273.  
  274.  
  275. class ImageTopic(HelpTopic):
  276.     """
  277.     A image Help Topic. Holds an ImageFile object.
  278.     """
  279.  
  280.     meta_type='Help Image'
  281.  
  282.     def __init__(self, id, title, file, categories=None, permissions=None):
  283.         self.id=id
  284.         self.title=title
  285.         dir, file=os.path.split(file)
  286.         self.image=ImageFile(file, dir)
  287.         if permissions is not None:
  288.             self.permissions=permissions
  289.         if categories is not None:
  290.             self.categories=categories  
  291.     
  292.     def index_html(self, REQUEST, RESPONSE):
  293.         "View the Help Topic"
  294.         return self.image.index_html(REQUEST, RESPONSE)
  295.         
  296.     def SearchableText(self):
  297.         "The full text of the Help Topic, for indexing purposes"
  298.         return ''
  299.         
  300.